Exclude properties of type never when emitting model schemas
#1127
Conversation
daviwil
requested review from
bterlson,
nguerrera,
markcowl,
allenjzhang and
timotheeguerin
as code owners
|
You can try these changes at https://cadlplayground.z22.web.core.windows.net/prs/1127/ Check the website changes at https://cadlwebsite.z1.web.core.windows.net/prs/1127/ |
| @@ -1046,6 +1046,11 @@ function createOAPIEmitter(program: Program, options: ResolvedOpenAPI3EmitterOpt | |||
| continue; | |||
| } | |||
|
|
|||
| if (isNeverType(prop.type)) { | |||
There was a problem hiding this comment.
Wondering if it would make sense to have this built at the checker level, like it doesn't even include the property in the model object then.
I guess the issue with it then is you can't project it if the property is not there.
There was a problem hiding this comment.
Yep, I think that's a good way to look at it. We might want to make the property have some other type in the future, so possibly better to leave it in at the checker level.
There was a problem hiding this comment.
Should we maybe open a design issue on this? It's also worth considering if failing that it would be good to put it in MetadataInfo.isPayloadProperty called just above. Upside, one fewer thing for an emitter that follows the (to-be-written, #1083) docs on metadata. Seems reasonable to say respond false to both isPayload and isMetadata for that. Speaking of which, do we need to handle @header something: never, etc.?
There was a problem hiding this comment.
This change is fine, just some thoughts for the future.
There was a problem hiding this comment.
Yep, I will open a design issue for it.
This came up while working on https://github.com/Azure/cadl-azure/pull/2022#discussion_r984714147:
In some library authoring cases, it would be nice if a templated type could have a property that can be discarded when the
nevertype is passed in. For example:This would enable spec authors to use
getOperationStatusorgetOperationStatus<MyResultType>without the need for two separate operation signatures. When theOperationStatustype is emitted in OpenAPI, theresultproperty will be elided whenneveris used in the operation signature.